Platform Explorer / Nuxeo Platform 2023.20

Component org.nuxeo.ecm.user.center.dashboard.jsf.layouts.dashboard

Documentation

This component defines the JSF dashboard grid layout.

@since 5.6

Resolution Order

901
The resolution order represents the order in which this component has been resolved by the Nuxeo Runtime framework.
You can influence this order by adding "require" tags in your component declaration, to make sure it is resolved after another component.

Contributions

XML Source

<?xml version="1.0"?>

<component name="org.nuxeo.ecm.user.center.dashboard.jsf.layouts.dashboard">

  <documentation>
    This component defines the JSF dashboard grid layout.

    @since 5.6
  </documentation>

  <extension target="org.nuxeo.ecm.platform.forms.layout.WebLayoutManager"
    point="layouts">

    <layout name="grid_dashboard_layout">
      <templates>
        <template mode="any">
          /layouts/layout_grid_template.xhtml
        </template>
      </templates>
      <rows>
        <row>
          <widget>dashboard_left</widget>
          <widget>dashboard_right</widget>
        </row>
      </rows>
    </layout>

  </extension>

  <extension target="org.nuxeo.ecm.platform.forms.layout.WebLayoutManager"
    point="widgets">

    <widget name="dashboard_left" type="documentActions">
      <labels>
        <label mode="any"></label>
      </labels>
      <properties widgetMode="any">
        <property name="category">DASHBOARD_LEFT</property>
      </properties>
      <controls mode="any">
        <control name="gridStyleClass">gridStyle6</control>
      </controls>
    </widget>

    <widget name="dashboard_right" type="documentActions">
      <labels>
        <label mode="any"></label>
      </labels>
      <properties widgetMode="any">
        <property name="category">DASHBOARD_RIGHT</property>
      </properties>
      <controls mode="any">
        <control name="gridStyleClass">gridStyle6</control>
      </controls>
    </widget>

    <widget name="dashboard_user_tasks" type="contentViewWithForms">
      <!-- handles labels to display the widget help within the widget -->
      <handlingLabels>true</handlingLabels>
      <labels>
        <label mode="any">title.dashboard.userTasks</label>
      </labels>
      <helpLabels>
        <label mode="any">label.workflow.tasks</label>
      </helpLabels>
      <translated>true</translated>
      <properties widgetMode="any">
        <property name="contentViewName">user_tasks</property>
        <property name="foldable">true</property>
        <property name="useAjaxPagination">true</property>
      </properties>
    </widget>

    <widget name="dashboard_user_workspaces" type="contentViewWithForms">
      <properties widgetMode="any">
        <property name="contentViewName">user_workspaces</property>
        <property name="foldable">true</property>
        <property name="hideEmpty">true</property>
        <property name="useAjaxPagination">true</property>
      </properties>
    </widget>

    <widget name="dashboard_user_sections" type="contentViewWithForms">
      <properties widgetMode="any">
        <property name="contentViewName">user_sections</property>
        <property name="foldable">true</property>
        <property name="hideEmpty">true</property>
        <property name="useAjaxPagination">true</property>
      </properties>
    </widget>

    <widget name="dashboard_user_documents" type="contentViewWithForms">
      <properties widgetMode="any">
        <property name="contentViewName">user_documents</property>
        <property name="foldable">true</property>
        <property name="hideEmpty">true</property>
        <property name="useAjaxPagination">true</property>
      </properties>
    </widget>

    <widget name="dashboard_domain_documents" type="contentViewWithForms">
      <properties widgetMode="any">
        <property name="contentViewName">domain_documents</property>
        <property name="foldable">true</property>
        <property name="hideEmpty">true</property>
        <property name="useAjaxPagination">true</property>
      </properties>
    </widget>

    <widget name="dashboard_domain_published_documents" type="contentViewWithForms">
      <properties widgetMode="any">
        <property name="contentViewName">domain_published_documents</property>
        <property name="foldable">true</property>
        <property name="hideEmpty">true</property>
        <property name="useAjaxPagination">true</property>
      </properties>
    </widget>

    <widget name="dashboard_user_sites" type="contentViewWithForms">
      <properties widgetMode="any">
        <property name="contentViewName">user_sites</property>
        <property name="foldable">true</property>
        <property name="hideEmpty">true</property>
        <property name="useAjaxPagination">true</property>
      </properties>
    </widget>

    <widget name="dashboard_user_deleted_documents" type="contentViewWithForms">
      <properties widgetMode="any">
        <property name="contentViewName">user_deleted_documents</property>
        <property name="foldable">true</property>
        <property name="hideEmpty">true</property>
        <property name="useAjaxPagination">true</property>
      </properties>
    </widget>

    <widget name="dashboard_user_favorites" type="contentViewWithForms">
      <properties widgetMode="any">
        <property name="contentViewName">user_favorites</property>
        <property name="foldable">true</property>
        <property name="hideEmpty">false</property>
        <property name="useAjaxPagination">true</property>
      </properties>
    </widget>

    <widget name="dashboard_user_shared_documents" type="contentViewWithForms">
      <properties widgetMode="any">
        <property name="contentViewName">user_shared_documents</property>
        <property name="foldable">true</property>
        <property name="hideEmpty">false</property>
        <property name="useAjaxPagination">true</property>
      </properties>
    </widget>

  </extension>

  <extension target="org.nuxeo.ecm.platform.actions.ActionService"
    point="actions">

    <documentation>
      Actions stacking widgets inside the default JSF dasboard

      @since 5.6
    </documentation>

    <action id="dashboard_user_favorites" type="widget" order="20">
      <category>DASHBOARD_LEFT</category>
      <properties>
        <property name="widgetName">dashboard_user_favorites</property>
      </properties>
    </action>

    <action id="dashboard_user_shared_documents" type="widget" order="30">
      <category>DASHBOARD_LEFT</category>
      <properties>
        <property name="widgetName">dashboard_user_shared_documents</property>
      </properties>
    </action>

    <action id="dashboard_user_tasks" type="widget" order="40">
      <category>DASHBOARD_LEFT</category>
      <properties>
        <property name="widgetName">dashboard_user_tasks</property>
      </properties>
    </action>

    <!-- dashboard_user_processes, with order 40, moved to addons -->

    <action id="dashboard_user_workspaces" type="widget" order="60">
      <category>DASHBOARD_LEFT</category>
      <properties>
        <property name="widgetName">dashboard_user_workspaces</property>
      </properties>
    </action>

    <action id="dashboard_user_sections" type="widget" order="80">
      <category>DASHBOARD_LEFT</category>
      <properties>
        <property name="widgetName">dashboard_user_sections</property>
      </properties>
    </action>

    <action id="dashboard_user_documents" type="widget" order="20">
      <category>DASHBOARD_RIGHT</category>
      <properties>
        <property name="widgetName">dashboard_user_documents</property>
      </properties>
    </action>

    <action id="dashboard_domain_documents" type="widget" order="40">
      <category>DASHBOARD_RIGHT</category>
      <properties>
        <property name="widgetName">dashboard_domain_documents</property>
      </properties>
    </action>

    <action id="dashboard_domain_published_documents" type="widget"
      order="60">
      <category>DASHBOARD_RIGHT</category>
      <properties>
        <property name="widgetName">dashboard_domain_published_documents</property>
      </properties>
    </action>

    <action id="dashboard_user_sites" type="widget" order="80">
      <category>DASHBOARD_RIGHT</category>
      <properties>
        <property name="widgetName">dashboard_user_sites</property>
      </properties>
    </action>

    <!-- disabled for now -->
    <action id="dashboard_user_deleted_documents" type="widget" order="100"
      enabled="false">
      <category>DASHBOARD_RIGHT</category>
      <properties>
        <property name="widgetName">dashboard_user_deleted_documents</property>
      </properties>
    </action>

  </extension>

</component>